//============================================================================
// Name        : documentation.h
// Authors     : Falvio Abreu Araujo & Yoan Collet
// Date        : 12/09/09
// Description : documentation pages for doxygen doc generator
//============================================================================

#ifndef DOCUMENTATION_H_
#define DOCUMENTATION_H_

/*!
 * \page MainPage Rules
 *
 */


/*! \page GUIPage How to use the GUI ?
 * At the beginning of GameOfLife, a graphical window (GUI) with an empty grid appears to the player.
 * Then the player can enable squares of the grid in pushing left mouse button on them.
 * Finally, the GUI possesses several buttons:
 * - a START button : begin GameOfLife in automatic mode
 * - a STOP  button : suspend GameOfLife (pause mode)
 * - a RESET button : reset GameOfLife to start point
 * - a NEXTSTEP button : begin GameOfLife in manual mode
 * - a PREVIOUSSTEP button : come back to previous step in manual mode
 * There is also a counter that indicates the number of the current step.
 * [Optional] an options list allow the player to choose what kind of rules he wants to play with.
 */

/*! \todo Create a svn (subversion) repository to store the project.
 * We'd can work on it at the same time without problem.
 */

#endif /* DOCUMENTATION_H_ */
